Improve process-get/process-put docstrings
authorStefan Kangas <stefankangas@gmail.com>
Sat, 1 Mar 2025 01:01:30 +0000 (02:01 +0100)
committerStefan Kangas <stefankangas@gmail.com>
Sat, 1 Mar 2025 05:36:43 +0000 (06:36 +0100)
* lisp/subr.el (process-get, process-put): Explain the purpose of these
functions in the docstring.

lisp/subr.el

index dfd91825363075b6d834155dd491aca763ac95f0..37a3f9efe6b6b4d2f5cbece981d77166f632a500 100644 (file)
@@ -3263,13 +3263,19 @@ process."
 
 (defun process-get (process propname)
   "Return the value of PROCESS' PROPNAME property.
-This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
+This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'.
+
+Together with `process-put', this can be used to store and retrieve
+miscellaneous values associated with the process."
   (declare (side-effect-free t))
   (plist-get (process-plist process) propname))
 
 (defun process-put (process propname value)
   "Change PROCESS' PROPNAME property to VALUE.
-It can be retrieved with `(process-get PROCESS PROPNAME)'."
+It can be retrieved with `(process-get PROCESS PROPNAME)'.
+
+Together with `process-get', this can be used to store and retrieve
+miscellaneous values associated with the process."
   (set-process-plist process
                     (plist-put (process-plist process) propname value)))